Lender Price API
Locking a Loan with LOS / 5. Export Pricing / 5.5 Add Export Pricing Lock Event
In This Topic
    5.5 Add Export Pricing Lock Event
    In This Topic

    After the loan has been updated, you need to lock your rate. Do this with the addLockEvent call, which creates a lockStatusLogic value of "Locked" for the entered priceQuoteId scenario, as well as update options for future use.

    Path

    /rest/v1/lp-ppe-api/price-quote/addLockEvent

    Headers

    secret

    {{token}}

    companyid

    {{companyId}}

    Path Parameters

    There are no path parameters

     

    Body

    The request passes the following IDs, along with a scenario lock, any exception or extension data if applicable, the date, and a comment:

    Copy Code
    {
        lockId: ObjectId;
        lockStatusId: ObjectId;
        priceQuoteId: ObjectId;
        lockEventExceptionInfo: LockEventExceptionInfo;
        lockEventExtensionInfo: LockEventExtensionInfo;
        scenario: ScenarioLock;
        lockDateUpdate: Date;
        lockEventComment: String;
    }

     Example Request

    Copy Code
    curl --location -g --request POST '{{protocol}}{{domain}}/rest/v1/lock/addLockEvent' \
    --header 'secret: {{token}}' \
    --header 'companyid: {{companyId}}' \
    --data-raw '{
        "lockId": "{{lockId}}",
        "lockStatusId": "{{lockStatusId}}",
        "priceQuoteId": "{{priceQuoteId}}",
        "lockEventExceptionInfo": null,
        "lockEventExtensionInfo": null
    }'

    Response

    The response returns the lock data and any modification data.